<!DOCTYPE html><html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>Squadron-Manager » \notification</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">Squadron-Manager</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
                                    API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Packages</a></li>
<li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
<li><a href="../packages/Squadron-Manager.html"><i class="icon-folder-open"></i> Squadron-Manager</a></li>
<li><a href="../packages/Squadron-manager.html"><i class="icon-folder-open"></i> Squadron-manager</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
                                    Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
                                    Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
                <span class="label label-info">178</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
                <ul></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
                <span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
                            Javascript is disabled; several features are only available
                            if Javascript is enabled.
                        </div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods
                    <ul>
<li class="method public "><a href="#method___construct" title="__construct :: Creates a new notification object"><span class="description">Creates a new notification object</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#method_check_display" title="check_display :: Checks if this notification has anything to display."><span class="description">Checks if this notification has anything to display.</span><pre>check_display()</pre></a></li>
<li class="method public "><a href="#method_display" title="display :: Displays the actual link if it needs to"><span class="description">Displays the actual link if it needs to</span><pre>display()</pre></a></li>
<li class="method public "><a href="#method_get_presid" title="get_presid :: "><span class="description">get_presid()
        </span><pre>get_presid()</pre></a></li>
</ul>
</li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties
                    <ul></ul>
</li>
<li class="nav-header private">» Private
                    <ul>
<li class="property private "><a href="#property_display" title="$display :: "><span class="description"></span><pre>$display</pre></a></li>
<li class="property private "><a href="#property_display_text" title="$display_text :: "><span class="description"></span><pre>$display_text</pre></a></li>
<li class="property private "><a href="#property_presidence" title="$presidence :: "><span class="description"></span><pre>$presidence</pre></a></li>
<li class="property private "><a href="#property_query" title="$query :: "><span class="description"></span><pre>$query</pre></a></li>
<li class="property private "><a href="#property_results" title="$results :: "><span class="description"></span><pre>$results</pre></a></li>
<li class="property private "><a href="#property_task_code" title="$task_code :: "><span class="description"></span><pre>$task_code</pre></a></li>
</ul>
</li>
</ul>
</div>
<div class="span8">
<a id="\notification"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li><a href="../namespaces/global.html">global</a></li>
<li class="active">
<span class="divider">\</span><a href="../classes/notification.html">notification</a>
</li>
</ul>
<div class="element class">
<p class="short_description">The class for notifications for a user.</p>
<div class="details">
<div class="long_description"><p>The notifications are associated with a staff task from the table TASKS
these are the pages the staff allowed to see.
If a staff member has permissions for that task he will have that notication.</p>

<p>The display string of the text has a special syntax.  Any normal text will be simply displayed
to display a query result enclose the column name (if renamed use the renamed column name) in **
Only the first row (0) will be used</p>

<p>if the column name contains DATE it will be parsed as a dateTime, and will follow the display constants for this project</p>

<p>i.e. There are <em>COUNT</em> testing requests
There was a request by <em>REQUEST_NAME</em> to clear the system log on <em>DATE</em>.</p>

<p>Presidence scale: 0-3
0: high priority- security breech
1: System administration needed
2:High-priority membership administration
3:low-priority membership administration</p></div>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
<h2>Creates a new notification object</h2>
<pre>__construct(String $query, String $text, int $prior, string $code) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>WARNING:INPUT cannot be cleaned because queries are being parsed. Do not create a notification from
user input, use ONLY input from the csv file</p></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$query</h4>
<code>String</code><p>-the query to run</p>
</div>
<div class="subelement argument">
<h4>$text</h4>
<code>String</code><p>text - the text to be displayed with special syntax
* The display string of the text has a special syntax.  Any normal text will be simply displayed
to display a query result enclose the column name (if renamed use the renamed column name) in **
Only the first row (0) will be used
if the column name contains DATE it will be parsed as a dateTime, and will follow the display constants for this project
i.e. There are <em>COUNT</em> testing requests
There was a request by <em>REQUEST_NAME</em> to clear the system log on <em>DATE</em>.</p>
</div>
<div class="subelement argument">
<h4>$prior</h4>
<code>int</code><ul>
<li>the presidence of the notification 0-3 scale</li>
</ul>
</div>
<div class="subelement argument">
<h4>$code</h4>
<code>string</code><p>-the task code for this notification from the database</p>
</div>
</div></div>
</div>
<a id="method_check_display"></a><div class="element clickable method public method_check_display" data-toggle="collapse" data-target=".method_check_display .collapse">
<h2>Checks if this notification has anything to display.</h2>
<pre>check_display($ident) : \boolean-Returns</pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"><p>It also runs the query and preps for the display.</p>

<p>WARNING: Do not use the User's database connection use the sandboxed one
instead.  These will be executing queries that may be tampered with.</p></div>
<h3>Parameters</h3>
<div class="subelement argument"><h4>$ident</h4></div>
<h3>Returns</h3>
<div class="subelement response">
<code>\boolean-Returns</code>true if this will be displayed, false otherwise</div>
</div></div>
</div>
<a id="method_display"></a><div class="element clickable method public method_display" data-toggle="collapse" data-target=".method_display .collapse">
<h2>Displays the actual link if it needs to</h2>
<pre>display(\mysqli $ident) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<div class="long_description"></div>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$ident</h4>
<code><a href="http://php.net/manual/en/class.mysqli.php">\mysqli</a></code><p>the database connection</p></div>
</div></div>
</div>
<a id="method_get_presid"></a><div class="element clickable method public method_get_presid" data-toggle="collapse" data-target=".method_get_presid .collapse">
<h2>get_presid()
        </h2>
<pre>get_presid() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a id="property_display"> </a><div class="element clickable property private property_display" data-toggle="collapse" data-target=".property_display .collapse">
<h2></h2>
<pre>$display </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property_display_text"> </a><div class="element clickable property private property_display_text" data-toggle="collapse" data-target=".property_display_text .collapse">
<h2></h2>
<pre>$display_text </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property_presidence"> </a><div class="element clickable property private property_presidence" data-toggle="collapse" data-target=".property_presidence .collapse">
<h2></h2>
<pre>$presidence </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property_query"> </a><div class="element clickable property private property_query" data-toggle="collapse" data-target=".property_query .collapse">
<h2></h2>
<pre>$query </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property_results"> </a><div class="element clickable property private property_results" data-toggle="collapse" data-target=".property_results .collapse">
<h2></h2>
<pre>$results </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
<a id="property_task_code"> </a><div class="element clickable property private property_task_code" data-toggle="collapse" data-target=".property_task_code .collapse">
<h2></h2>
<pre>$task_code </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
            Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a12</a> and<br>
            generated on 2013-10-13T16:49:20-06:00.<br></footer></div>
</div>
</body>
</html>
